クレジットカード決済 会員カード登録 API一覧
HTTP仕様(.idPass)
HTTP仕様(.json)
Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: text/plain;charset=windows-31j |
|
Status Code |
200:常に200を返却 |
Request header |
Content-Type: application/json;charset=UTF-8 |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: application/json;charset=UTF-8 |
|
Status Code |
|
・E90010001
・E92000001
・E92000002
・E91099996
・E91099997
SaveMember 会員登録
指定したサイトに会員を登録します。
リクエスト
SiteID | siteID | 必須 半角英数13桁
サイトID |
||
---|---|---|---|---|
SitePass | sitePass | 必須 半角英数10桁
サイトパスワード |
||
MemberID | memberID | 必須 半角英数記号60桁
会員ID |
||
MemberName | memberName | 全半角255桁
会員名 |
/payment/SaveMember.json
{
"siteID":"tsite99887902",
"sitePass":"PASSWORD",
"memberID":"member01"
}
/payment/SaveMember.idPass
SiteID=tsite99887902&SitePass=PASSWORD&MemberID=member01
UpdateMember 会員更新
指定したサイトの会員情報を更新します。
リクエスト
SiteID | siteID | 必須 半角英数13桁
サイトID |
||
---|---|---|---|---|
SitePass | sitePass | 必須 半角英数10桁
サイトパスワード |
||
MemberID | memberID | 必須 半角英数記号60桁
会員ID |
||
MemberName | memberName | 全半角255桁
会員名 |
/payment/UpdateMember.json
{
"siteID":"tsite99887902",
"sitePass":"PASSWORD",
"memberID":"member01"
}
/payment/UpdateMember.idPass
SiteID=tsite99887902&SitePass=PASSWORD&MemberID=member01
SearchMember 会員参照
指定したサイトの会員情報を参照します。
リクエスト
SiteID | siteID | 必須 半角英数13桁
サイトID |
||
---|---|---|---|---|
SitePass | sitePass | 必須 半角英数10桁
サイトパスワード |
||
MemberID | memberID | 必須 半角英数記号60桁
会員ID |
/payment/SearchMember.json
{
"siteID":"tsite99887902",
"sitePass":"PASSWORD",
"memberID":"member01"
}
/payment/SearchMember.idPass
SiteID=tsite99887902&SitePass=PASSWORD&MemberID=member01
レスポンス
{
"memberID":"member01",
"memberName":"membername01",
"deleteFlag":"0"
}
MemberID=member01&MemberName=membername01&DeleteFlag=0
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
DeleteMember 会員削除
指定したサイトの会員情報を削除します。
リクエスト
SiteID | siteID | 必須 半角英数13桁
サイトID |
||
---|---|---|---|---|
SitePass | sitePass | 必須 半角英数10桁
サイトパスワード |
||
MemberID | memberID | 必須 半角英数記号60桁
会員ID |
/payment/DeleteMember.json
{
"siteID":"tsite99887902",
"sitePass":"PASSWORD",
"memberID":"member01"
}
/payment/DeleteMember.idPass
SiteID=tsite99887902&SitePass=PASSWORD&MemberID=member01
SaveCard カード登録/更新
指定した会員にカード情報を登録します。また、登録連番を指定することで保有情報の更新を行うことも可能です。
なお、登録/更新を行う際には、サイトに設定されたショップIDを使用してカード会社と通信を行いカード情報が有効であるかを確認し有効な情報だけを保持します。
決済完了後にカード情報を更新した場合は、決済時のカード情報は取得できなくなります。
登録方法を選択し、必要なパラメータを設定してください。
どちらも指定した場合、トークンが優先されます。
-
カード番号を利用して登録する場合
カード番号の取り扱いが許可された加盟店様のみ利用可能です。
-
トークンを利用して登録する場合
トークン発行後、呼び出してください。
カード登録連番は、指定したモードにより返却される内容が異なります。
また、登録連番を指定せずに物理モードでカード登録/更新を行った場合は、論理モードと異なり以下のような動作をしますのでご注意ください。
1) これから登録するカード番号と同一のカード番号が未登録の場合
新規として登録され、新しい登録連番が返却されます。
2) これから登録するカード番号と同一のカード番号が登録済みの場合
更新として認識され、カード番号以外の情報は更新します。該当した登録連番が返却されます。
なお、同一カード番号が登録済みの場合であっても、削除済みの場合は更新の対象外となります。
(有効期限のみを更新したい場合を想定しています)
削除済みのカード情報を更新した場合、削除フラグが0となります。
リクエスト
SiteID | siteID |
必須
半角英数13桁
サイトID |
||
---|---|---|---|---|
SitePass | sitePass |
必須
半角英数10桁
サイトパスワード |
||
MemberID | memberID |
必須
半角英数記号60桁
会員ID |
||
SeqMode | seqMode |
半角数字1桁
カード登録連番モード
処理区分が「有効性チェック」の場合は設定不要 |
||
CardSeq | cardSeq |
半角数字4桁
カード登録連番更新時に必須、登録時は不要です。 |
||
DefaultFlag | defaultFlag |
半角数字1桁
デフォルトフラグ
|
||
CardName | cardName |
全半角10桁
カード会社略称登録するカードのカード会社等 |
||
UpdateType | updateType |
半角数字1桁
カード番号更新区分
※更新時のみ有効です。また、トークンを指定した場合はUpdateTypeの指定は無視され、トークンの情報でカード番号も更新されます。 |
カード番号を利用する場合
各パラメータはカード番号利用のみ設定してください。
CardNo | cardNo |
必須
カード番号 |
||
---|---|---|---|---|
CardPass | cardPass |
半角英数20桁
カードパスワード決済時に必要となるカードパスワード |
||
Expire | expire |
必須半角数字4桁 固定
有効期限YYMM形式 |
||
HolderName | holderName |
半角英数50桁
名義人 |
||
SecurityCode | securityCode |
半角数字4桁
セキュリティーコードカードに記載されている3桁もしくは4桁の数字 |
/payment/SaveCard.json
{
"siteID":"tsite99887814",
"sitePass":"PASSWORD",
"memberID":"member01",
"cardNo":"41111111****1111",
"expire":"2208"
}
{
"siteID":"tsite99887814",
"sitePass":"PASSWORD",
"memberID":"member01",
"token":"8d78c4158f9c4921823a7dcb43e754bee1b137df82ee8062a16ba26e1007f0cb"
}
/payment/SaveCard.idPass
SiteID=tsite99887814&SitePass=PASSWORD&MemberID=member01&CardNo=41111111****1111&Expire=2208
SiteID=tsite99887814&SitePass=PASSWORD&MemberID=member01&Token=8d78c4158f9c4921823a7dcb43e754bee1b137df82ee8062a16ba26e1007f0cb
レスポンス
正常
CardSeq | cardSeq |
半角数字4桁
カード登録連番同一カードでも、モードにより返却内容が異なります。 |
||
---|---|---|---|---|
CardNo | cardNo |
半角英数16桁
カード番号サイト設定のマスクレベルを利用する場合は設定に応じてマスクされた値、利用しない場合は下4桁以外マスクされた値を返却します。 |
||
Forward | forward |
半角英数7桁
仕向先コード |
以下カード属性照会APIの契約がある場合に返却されます。
カード属性情報は、弊社が保有する情報を元に出力します。
Brand | brand |
半角英字16桁
国際ブランド
判別不能時は空文字を返却します。 |
||
---|---|---|---|---|
DomesticFlag | domesticFlag |
半角数字1桁
国内発行フラグ
|
||
IssuerCode | issuerCode |
半角英数7桁
イシュアコードイシュアを特定できた場合のみ返却します。 |
||
DebitPrepaidFlag | debitPrepaidFlag |
半角数字1桁
デビット/プリペイドフラグ
|
||
DebitPrepaidIssuerName | debitPrepaidIssuerName |
半角英数75桁
デビット/プリペイドカード発行会社名デビット(DebitPrepaidFlag =1)もしくはプリペイド(DebitPrepaidFlag =2)の場合のみ返却します。 |
||
ForwardFinal | forwardFinal |
半角英数7桁
最終仕向先コードデビット(DebitPrepaidFlag =1)もしくはプリペイド(DebitPrepaidFlag =2)の場合のみ返却します。 |
{
"cardSeq":"1456",
"cardNo":"************9999",
"forward":"2SF37F6",
"brand":"VISA",
"domesticFlag":"0",
"issuerCode":"2SFBAF6",
"debitPrepaidFlag":"2",
"debitPrepaidIssuerName":"aaabbb(株)",
"forwardFinal":"2SF37F6"
}
[
{
"errCode":"M01",
"errInfo":"M01470008"
}
]
CardSeq=1456&CardNo=************9999&Forward=2SF37F6&Brand=VISA&DomesticFlag=0&IssuerCode=2SFBAF6&DebitPrepaidFlag=2&DebitPrepaidIssuerName=aaabbb(株)&ForwardFinal=2SF37F6
ErrCode=M01&ErrInfo=M01470008
TradedCard 決済後カード登録
指定したオーダーIDの取引に使用したカードを登録します。
決済にて有効性の確認が取れていますので、カード会社への有効性チェックは行いません。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード |
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID加盟店様が取引を識別するための値 |
||
SiteID | siteID | 必須 半角英数13桁
サイトID |
||
SitePass | sitePass | 必須 半角英数10桁
サイトパスワード |
||
MemberID | memberID | 必須 半角英数記号60桁
会員ID |
||
SeqMode | seqMode | 半角数字1桁
カード登録連番モード
|
||
DefaultFlag | defaultFlag | 半角数字1桁
デフォルトフラグ
|
||
CardSeq | cardSeq | 半角数字4桁
カード登録連番
入力無しの場合、登録になります。 |
||
HolderName | holderName | 半角英数50桁
名義人省略した場合、決済時に指定した値は設定されません。 |
||
CardName | cardName | 全半角10桁
カード会社略称省略した場合、決済時に指定した値は設定されません。 |
||
CardPass | cardPass | 半角英数20桁
カードパスワード省略した場合、決済時に指定した値は設定されません。 |
||
UseSiteMaskLevel | useSiteMaskLevel | 半角数字1桁
サイト設定のマスクレベル利用有無出力パラメータのカード番号へのマスクをサイト情報に設定してある値を利用して行うかを設定します。
|
/payment/TradedCard.json
{
"shopID":"tshop99887902",
"shopPass":"PASSWORD",
"orderID":"TEST-20190628-115812",
"siteID":"tsite99887902",
"sitePass":"PASSWORD",
"memberID":"member01"
}
/payment/TradedCard.idPass
ShopID=tshop99887902&ShopPass=PASSWORD&OrderID=TEST-20190628-115812&SiteID=tsite99887902&SitePass=PASSWORD&MemberID=member01
レスポンス
{
"cardSeq":"1",
"cardNo":"************9999",
"forward":"2SF37F6"
}
CardSeq=1&CardNo=************9999&Forward=2SF37F6
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
SearchCard カード照会
指定した会員のカード情報を参照します。
同一会員に複数カードが登録されている場合は"|"で区切って返却します。
リクエスト
SiteID | siteID | 必須 半角英数13桁
サイトID弊社が発行する値を設定します。 |
||
---|---|---|---|---|
SitePass | sitePass | 必須 半角英数10桁
サイトパスワード弊社が発行する値を設定します。 |
||
MemberID | memberID | 必須 半角英数記号60桁
会員IDカードを登録する対象の会員IDを設定します。 |
||
SeqMode | seqMode | 半角数字1桁
カード登録連番モード
|
||
ValidFlag | validFlag | 半角数字1桁
有効カードフラグ
|
||
CardSeq | cardSeq | 半角数字4桁
カード登録連番参照するカードの登録連番を設定します。 |
||
UseFloatingMask | useFloatingMask | 半角数字1桁
可変マスク利用有無
|
/payment/SearchCard.json
{
"siteID":"tsite99887902",
"sitePass":"PASSWORD",
"memberID":"member01"
}
/payment/SearchCard.idPass
SiteID=tsite99887902&SitePass=PASSWORD&MemberID=member01
レスポンス
正常
CardSeq | cardSeq | 半角数字4桁 固定
カード登録連番 |
||
---|---|---|---|---|
DefaultFlag | defaultFlag | 半角数字1桁 固定
デフォルトフラグ |
||
CardName | cardName | 全半角10桁
カード会社略称 |
||
CardNo | cardNo | 半角数字16桁
カード番号 |
||
Expire | expire | 半角数字4桁
有効期限 |
||
HolderName | holderName | 半角英数50桁
名義人 |
||
DeleteFlag | deleteFlag | 半角数字1桁
削除フラグ |
カード属性照会APIが利用可能な場合は、以下の情報も出力します。(※)
Brand | brand | 半角英字16桁
国際ブランド |
||
---|---|---|---|---|
DomesticFlag | domesticFlag | 半角数字1桁
国内発行フラグ |
||
IssuerCode | issuerCode | 半角英数7桁
イシュアコード |
||
DebitPrepaidFlag | debitPrepaidFlag | 半角数字1桁
デビット/プリペイドフラグ |
||
DebitPrepaidIssuerName | debitPrepaidIssuerName | 全半角75桁
デビット/プリペイドカード発行会社名 |
||
ForwardFinal | forwardFinal | 半角英数7桁
最終仕向先コード |
[
{
"cardSeq":"1456",
"defaultFlag":"1",
"cardName":"TESTCARD",
"cardNo":"************9999",
"expire":"2012",
"holderName":"human",
"deleteFlag":"0",
"brand":"VISA",
"domesticFlag":"0",
"issuerCode":"2SFBAF6",
"debitPrepaidFlag":"2",
"debitPrepaidIssuerName":"aaabbb(株)",
"forwardFinal":"2SF37F6"
}
]
CardSeq=1456&DefaultFlag=1&CardName=TESTCARD&CardNo=************9999&Expire=2012&HolderName=human&DeleteFlag=0&Brand=VISA&DomesticFlag=0&IssuerCode=2SFBAF6&DebitPrepaidFlag=2&DebitPrepaidIssuerName=aaabbb(株)&ForwardFinal=2SF37F6
[
{
"cardSeq":"0",
"defaultFlag":"0",
"cardName":"TESTCARD1",
"cardNo":"************9999",
"expire":"2803",
"holderName":"human",
"deleteFlag":"0",
"brand":"VISA",
"domesticFlag":"1",
"issuerCode":"2SFBAF6",
"debitPrepaidFlag":"2",
"debitPrepaidIssuerName":"aaabbb(株)",
"forwardFinal":"2SF37F6"
},
{
"cardSeq":"1",
"defaultFlag":"1",
"cardName":"TESTCARD2",
"cardNo":"************9999",
"expire":"2905",
"holderName":"human",
"deleteFlag":"0",
"brand":"MASTER",
"domesticFlag":"1",
"issuerCode":"2SFBAF6",
"debitPrepaidFlag":"2",
"debitPrepaidIssuerName":"aaabbb(株)",
"forwardFinal":"2SF37F6"
}
]
CardSeq=0|1&DefaultFlag=0|1&CardName=TESTCARD1|TESTCARD2&CardNo=************9999|************9999&Expire=2803|2905&HolderName=human|human&DeleteFlag=0|0&Brand=VISA|MASTER&DomesticFlag=1|1&IssuerCode=2SFBAF6|2SFBAF6&DebitPrepaidFlag=2|2&DebitPrepaidIssuerName=aaabbb(株)|aaabbb(株)&ForwardFinal=2SF37F6|2SF37F6
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
SearchCardDetail カード属性照会
指定したクレジットカードの属性情報を取得します。
※本APIを利用するには契約が必要です。
※本APIで返却する情報は、弊社で保持するBIN情報を元に判定しています。
指定方法を選択し、必要なパラメータを設定してください。
他指定方法のパラメータを指定した場合、想定外の方法で処理されることがございますのでご注意ください。
-
クレジットカード番号
クレジットカード番号の取り扱いが許可された加盟店様のみ利用可能です。
詳細については 入出力パラメータのカード番号の制限についてをご参照ください。 -
トークン
指定したトークンのクレジットカード番号の属性情報を取得します。
トークン発行後、呼び出してください。 -
ショップID+オーダーID
取引で使用されたカード番号の属性情報を取得します。
-
サイトID+会員ID(+カード登録連番)
サイトIDと会員IDに緋付くクレジットカード番号の属性情報を取得します。
・カード登録連番を指定した場合は、該当するカード情報のカード番号の属性情報を取得します。
・カード登録連番を省略した場合は、会員IDに登録されているすべてのカードの属性情報を返却します。
リクエスト
クレジットカード番号指定
各パラメータはクレジットカード番号指定のみ設定してください。
ShopID | shopID |
必須
半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shoppass |
必須
半角英数64桁
ショップパスワード |
||
CardNo | cardNo |
必須
半角数字16桁
カード番号 |
||
SearchType | searchType |
半角数字1桁
検索タイプ1:独自BINに設定された情報を返却します。 |
||
UseFloatingMask | useFloatingMask |
半角数字1桁
可変マスク利用有無
|
トークン指定
各パラメータはトークン指定のみ設定してください。
ShopID | shopID |
必須
半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shopPass |
必須
半角英数64桁
ショップパスワード |
||
Token | token |
必須
半角英数
トークンカード番号をトークン化した値を設定
|
||
SearchType | searchType |
半角数字1桁
検索タイプ1:独自BINに設定された情報を返却します。 |
||
UseFloatingMask | useFloatingMask |
半角数字1桁
可変マスク利用有無
|
ショップID+オーダーID指定
各パラメータはショップID+オーダーID指定のみ設定してください。
ShopID | shopID |
必須
半角英数13桁
ショップID |
||
---|---|---|---|---|
ShopPass | shoppass |
必須
半角英数64桁
ショップパスワード |
||
OrderID | orderID |
必須
半角英数27桁
オーダーID対象となる取引にカード番号が登録されている必要があります。(ExecTranが実行済みであること)
|
||
SearchType | searchType |
半角数字1桁
検索タイプ1:独自BINに設定された情報を返却します。 |
||
UseFloatingMask | useFloatingMask |
半角英数1桁
可変マスク利用有無
|
サイトID+会員ID(+カード登録連番)指定
各パラメータはサイトID+会員ID(+カード登録連番)指定のみ設定してください。
ShopID | shopID |
半角英数13桁
ショップID「検索タイプ」に 1 を指定した場合に必須です。 |
||
---|---|---|---|---|
ShopPass | shoppass |
半角英数64桁
ショップパスワード「検索タイプ」に 1 を指定した場合に必須です。 |
||
SiteID | siteID |
必須
半角英数13桁
サイトID |
||
SitePass | sitePass |
必須
半角英数10桁
サイトパスワード |
||
MemberID | memberID |
必須
半角英数記号60桁
会員ID |
||
SeqMode | seqMode |
半角数字1桁
カード登録連番モード
|
||
CardSeq | cardSeq |
半角数字4桁
カード登録連番参照するカードの登録連番を設定します。
|
||
SearchType | searchType |
半角数字1桁
検索タイプ1:独自BINに設定された情報を返却します。 |
||
UseFloatingMask | useFloatingMask |
半角英数1桁
可変マスク利用有無
|
/payment/SearchCardDetail.json
{
"token":"326f5a6f37b4d5221e93fd9c4a32dffc9116d687864df1612f86a992e1e49602",
"shopID":"tshop99887902",
"shopPass":"PASSWORD"
}
{
"siteID":"tsite99887814",
"sitePass":"PASSWORD",
"memberID":"member01"
}
{
"cardNo":"411111******1111",
"shopID":"tshop99887902",
"shopPass":"PASSWORD"
}
/payment/SearchCardDetail.idPass
Token=326f5a6f37b4d5221e93fd9c4a32dffc9116d687864df1612f86a992e1e49602&ShopID=tshop99887902&ShopPass=PASSWORD
SiteID=tsite99887814&SitePass=PASSWORD&MemberID=member01
CardNo=411111******1111&ShopID=tshop99887902&ShopPass=PASSWORD
レスポンス
正常
CardNo | cardNo |
半角数字16桁
カード番号カード番号へのマスクはサイト情報に設定してある値を使用して行います。
|
||
---|---|---|---|---|
Brand | brand |
半角英字16桁
国際ブランド
判別不能時は空文字を返却します。 |
||
DomesticFlag | domesticFlag |
半角数字1桁 固定
国内発行フラグ
|
||
IssuerCode | issuerCode |
半角英数7桁
イシュアコード国内発行カード(DomesticFlag =1)の場合のみ返却します。 |
||
DebitPrepaidFlag | debitPrepaidFlag |
半角数字1桁 固定
デビット/プリペイドフラグ
|
||
DebitPrepaidIssuerName | debitPrepaidIssuerName |
全半角75桁
デビット/プリペイドカード発行会社名デビット(DebitPrepaidFlag =1)もしくはプリペイド(DebitPrepaidFlag =2)の場合のみ返却します。 |
||
ForwardFinal | forwardFinal | 半角英数7桁
最終仕向先コード |
||
Info1 | info1 | 全半角100桁
加盟店設定情報1検索タイプ=1を指定した場合に独自BINに設定された情報を返却されます。 |
||
Info2 | info2 | 全半角100桁
加盟店設定情報2 |
||
Info3 | info3 | 全半角100桁
加盟店設定情報3 |
||
Info4 | info4 | 全半角100桁
加盟店設定情報4 |
||
Info5 | info5 | 全半角100桁
加盟店設定情報5 |
[
{
"cardNo":"************9999",
"brand":"VISA",
"domesticFlag":"0",
"issuerCode":"2SFBAF6",
"debitPrepaidFlag":"2",
"debitPrepaidIssuerName":"aaabbb(株)",
"forwardFinal":"2SF37F6"
}
]
CardNo=************9999&Brand=VISA&DomesticFlag=0&IssuerCode=2SFBAF6&DebitPrepaidFlag=2&DebitPrepaidIssuerName=aaabbb(株)&ForwardFinal=2SF37F6
[
{
"cardNo":"************9999",
"brand":"VISA",
"domesticFlag":"0",
"issuerCode":"2SFBAF6",
"debitPrepaidFlag":"2",
"debitPrepaidIssuerName":"aaabbb(株)",
"forwardFinal":"2SF37F6"
},
{
"cardNo":"************9999",
"brand":"MASTER",
"domesticFlag":"0",
"issuerCode":"2SFBAF6",
"debitPrepaidFlag":"2",
"debitPrepaidIssuerName":"aaabbb(株)",
"forwardFinal":"2SF37F6"
}
]
CardNo=************9999|************9999&Brand=VISA|MASTER&DomesticFlag=0|0&IssuerCode=2SFBAF6|2SFBAF6&DebitPrepaidFlag=2|2&DebitPrepaidIssuerName=aaabbb(株)|aaabbb(株)&ForwardFinal=2SF37F6|2SF37F6
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
DeleteCard カード削除
指定した会員のカード情報を削除します。
リクエスト
SiteID | siteID | 必須 半角英数13桁
サイトID |
||
---|---|---|---|---|
SitePass | sitePass | 必須 半角英数10桁
サイトパスワード |
||
MemberID | memberID | 必須 半角英数記号60桁
会員ID |
||
SeqMode | seqMode | 半角数字1桁 固定
カード登録連番モード
|
||
CardSeq | cardSeq | 必須 半角数字4桁
カード登録連番 |
/payment/DeleteCard.json
{
"siteID":"tsite99887902",
"sitePass":"PASSWORD",
"memberID":"member01",
"cardSeq":"4823"
}
/payment/DeleteCard.idPass
SiteID=tsite99887902&SitePass=PASSWORD&MemberID=member01&CardSeq=4823